11.5 删除用户目录
基本信息
Path： /api/v1/userDirectory/delete
Method： POST
接口描述：
- 对于删除接口，如果删除已经不存在的数据，不会报错，这会认为是成功的操作，返回状态码200且错误码为0
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 必须 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| idList | string [] | 和nameList二选一，都传时以idList为主 | 用户目录id列表 | ||
| nameList | string [] | 和idList二选一，都传时以idList为主 | 用户目录名列表 | >=2.2.16 开始支持此参数 |
请求示例
{
"nameList": [
"userDirectory1",
"userDirectory2"
]
}
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | number | 必须 | 0:成功， | ||
| data | object | 必须 | |||
| msg | string | 必须 |
返回示例
{
"code": 0,
"data": {},
"msg": "请求成功"
}
错误信息
| 错误提示 | 错误码 |
|---|---|
| 参数检查出错 | 10000001 |
| 用户目录不存在 | 7521 |
| 默认用户目录，不允许修改、删除 | 77200008 |
| 同步任务正在执行中，不允许修改、删除 | 77200008 |
| 删除当前用户目录需先手动清除当前用户目录所有数据再重试，包括组织架构/角色/用户 | 77200008 |
| 用户目录与认证服务器绑定，需要解除绑定才能删除 | 77200030 |
| 删除失败 | 10000000 |